<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../../print.css" type="text/css" media="print">
<meta content="PolylineMarker,com.modestmaps.core.PolylineMarker,maxTitleSize,minTitleSize,subTitleFormat,titleFormat,subTitleText,titleText" name="keywords">
<title>com.modestmaps.core.PolylineMarker</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'PolylineMarker - The San Diego Union-Tribune extensions library for the ModestMaps API - - PolylineOverlay and Supporting Classes';
				var baseRef = '../../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">The San Diego Union-Tribune Mapping extensions for the ModestMaps API -- PolylineOverlay and Supporting Classes</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../all-classes.html')" href="../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../all-classes.html')" href="../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../index-list.html')" href="../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../index.html?com/modestmaps/core/PolylineMarker.html&amp;com/modestmaps/core/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;PolylineMarker</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class PolylineMarker"); titleBar_setSubNav(false,true,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">com.modestmaps.core</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class PolylineMarker</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">PolylineMarker <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../images/inherit-arrow.gif"> flash.display.Sprite</td>
</tr>
</table>
<p></p>
  Draws a marker within a PolylineOverlay on the map. 
  <p>
  Marker consists of a title string and a sub-title string. The marker text is auto-scaled 
  to fit within the bounding box of the containing PolylineOverlay. The text size ranges 
  from the specified minimum to the specified maximum font size, always selecting 
  the largest font that will fit withing the bounding box.</p> 
  <p>
  "Bounding Box" refers to a rectangle that circumscribes the PolylineOverlay, 
  or that portion of the overlay that is currently visible on screen. 
  The marker also is auto-centered vertically and horizontally within that bounding box. 
  </p>
   <p></p>
<p>
<span class="classHeaderTableLabel">See also</span>
</p>
<div class="seeAlso">
<a href="http://www.modestmaps.com" target="mm_external">the official ModestMaps site</a>
<br>
<a href="../extras/Overlay.html" target="">Overlay</a>
<br>
<a href="../extras/PolylineOverlay.html" target="">PolylineOverlay</a>
<br>
<a href="../../modestmaps/Map.html" target="">Map</a>
</div>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#maxTitleSize">maxTitleSize</a> : uint = 20<div class="summaryTableDescription"> 
   Specifies the maximum displayable size of the title text for auto-scaling.</div>
</td><td class="summaryTableOwnerCol">PolylineMarker</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#minTitleSize">minTitleSize</a> : uint = 10<div class="summaryTableDescription"> 
   Specifies the minimum displayable size of the title text for auto-scaling.</div>
</td><td class="summaryTableOwnerCol">PolylineMarker</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#subTitleFormat">subTitleFormat</a> : TextFormat<div class="summaryTableDescription"> 
   Formatter for the sub-title text.</div>
</td><td class="summaryTableOwnerCol">PolylineMarker</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#subTitleText">subTitleText</a> : String<div class="summaryTableDescription">[read-only] returns the sub-title text of this marker </div>
</td><td class="summaryTableOwnerCol">PolylineMarker</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#titleFormat">titleFormat</a> : TextFormat<div class="summaryTableDescription"> 
   Formatter for the title text.</div>
</td><td class="summaryTableOwnerCol">PolylineMarker</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#titleText">titleText</a> : String<div class="summaryTableDescription">[read-only] returns the title text of this marker </div>
</td><td class="summaryTableOwnerCol">PolylineMarker</td>
</tr>
</table>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#PolylineMarker()">PolylineMarker</a>(titleText:String, subTitleText:String, region:<a href="../extras/PolylineOverlay.html">PolylineOverlay</a>, theMap:<a href="../Map.html">Map</a>)</div>
<div class="summaryTableDescription">
   Construct a new PolylineMarker instance with the specified title and subTitle,
   for the specified PolylineOverlay and Map.</div>
</td><td class="summaryTableOwnerCol">PolylineMarker</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="propertyDetail"></a>
<div class="detailSectionHeader">Property detail</div>
<a name="maxTitleSize"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">maxTitleSize</td><td class="detailHeaderType">property</td>
</tr>
</table>
<div class="detailBody">
<code>public var maxTitleSize:uint = 20</code><p> 
   Specifies the maximum displayable size of the title text for auto-scaling.
   Default value=10.
   </p></div>
<a name="minTitleSize"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">minTitleSize</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var minTitleSize:uint = 10</code><p> 
   Specifies the minimum displayable size of the title text for auto-scaling.
   Default value=20.
   </p></div>
<a name="subTitleFormat"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">subTitleFormat</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var subTitleFormat:TextFormat</code><p> 
   Formatter for the sub-title text.
   Default value = 18 point Arial white.
   </p></div>
<a name="subTitleText"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">subTitleText</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>subTitleText:String</code>&nbsp;&nbsp;[read-only]<p> returns the sub-title text of this marker </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get subTitleText():String</code>
<br>
</div>
<a name="titleFormat"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">titleFormat</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var titleFormat:TextFormat</code><p> 
   Formatter for the title text.
   Default value = 20 point Arial white.
   </p></div>
<a name="titleText"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">titleText</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>titleText:String</code>&nbsp;&nbsp;[read-only]<p> returns the title text of this marker </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get titleText():String</code>
<br>
</div>
<a name="constructorDetail"></a>
<div class="detailSectionHeader">Constructor detail</div>
<a name="PolylineMarker()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">PolylineMarker</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
</tr>
</table>
<div class="detailBody">
<code>public function PolylineMarker(titleText:String, subTitleText:String, region:<a href="../extras/PolylineOverlay.html">PolylineOverlay</a>, theMap:<a href="../Map.html">Map</a>)</code><p>
   Construct a new PolylineMarker instance with the specified title and subTitle,
   for the specified PolylineOverlay and Map.
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">titleText</span>:String</code> &mdash; is the text to be drawn as the top line of the marker.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">subTitleText</span>:String</code> &mdash; is the text to be drawn as the second line of the marker. 
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">region</span>:<a href="../extras/PolylineOverlay.html">PolylineOverlay</a></code> &mdash; is a handle on the PolylineOverlay where this marker is to be drawn.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">theMap</span>:<a href="../Map.html">Map</a></code> &mdash; is a handle on the map where this marker is to be drawn.
   </td>
</tr>
</table>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright">Extensions to Modestmaps by The San Diego Union-Tribune, June 2008</center>
</div>
</body>
</html>
<!--Extensions to Modestmaps by The San Diego Union-Tribune, June 2008-->
